Modify the properties of a documentation command.
Context
You can change the following properties for a documentation command:
- Collating multi-paged graphics: One graphic is created per page for multi-pages diagrams; one graphic per page is generated for the documentation. This means that a diagram may be split onto more than one page. You can use this option to force generation of a single graphic onto one page (this will then of course be reduced in size accordingly).
- Post-processing command: A command can be set for XML and Word formats. This is automatically carried out upon documentation creation; the $(INFILE) placeholder is replaced by the name of the output file in the call arguments. This enables e.g. Word or another application to be called for the generated output file.
- Postprocessing: Call arguments for the post-processing command.
- Java command: The Java command which is called if the post-processing command is inojava.
- Suppress all empty chapters: If this option is set, all empty model element enumeration chapters are suppressed as model components upon documentation generation. Normally the heading and an entry can be seen at the very least in the table of contents and index of documentation for such chapters.
- Convert chapter headings to dash lists: If this option is set to Never, model element enumeration chapters without subchapters are shown as headings.If this option is set to Leaf Nodes within Structure Tree Only, model element enumeration chapters which did not have a subchapter set for them in the documentation structure are converted into dash lists. Headings are not displayed for these.If this option is set to Dynamically, as well as the previous option, the same action is also carried out for the model element enumeration chapters which have subchapters in the documentation structure but do not have any in the resulting document due to the modeled information.
Note: The Leaf Nodes within Structure Tree Onlyoption is not supported in I4BA.
- Open result: You can set whether the result file should be opened always, never or with prompt user.
Attention: The result is always open in preview mode.
This option is not used if a post-processing command is entered.
- Use least common package as root: If the documentation structure uses the hierarchy tree or namespace tree, model components above the first common predecessor are not shown in the documentation structure.
- Documentation selection: The documentation selection used.
- Owner: The profile which the documentation command is in.
The following properties can only be edited in Innovator eXcellence:
- Output as I4BA documentation: If this option is set, the I4BA generator is used.
- Start structure level: A heading level can be entered for the chapter at the top-most level for a documentation in MS Word format (important for Innovator Report).
- Generate excerpt from model: If this option is set, an output documentation is created.
- Remove input repositories on success: If this option is set, information files are deleted upon successful documentation generation.
- Don't build picture output files: If this option is set, no graphics are generated.
- Don't check characters: If this option is set, text is not checked for invalid characters.